feat(spring-jakarta): [Queue Instrumentation 4] Add Kafka consumer instrumentation by adinauer · Pull Request #5255 · getsentry/sentry-java

adinauer · 2026-04-01T14:26:56Z

PR Stack (Queue Instrumentation)

feat(core): [Queue Instrumentation 1] Add enableQueueTracing option and messaging span data conventions #5250
feat(samples): [Queue Instrumentation 2] Add Kafka to Spring Boot 3 sample app #5253
feat(spring-jakarta): [Queue Instrumentation 3] Add Kafka producer instrumentation #5254
feat(spring-jakarta): [Queue Instrumentation 4] Add Kafka consumer instrumentation #5255
feat(spring-boot-jakarta): [Queue Instrumentation 5] Add Kafka queue auto-configuration #5259
test(samples): [Queue Instrumentation 6] Add Kafka queue system tests #5260
feat(samples): [Queue Instrumentation 7] Add Kafka to Spring Boot 3 OTel sample apps #5265
fix(spring-boot-jakarta): [Queue Instrumentation 8] Disable Sentry Kafka spans when OTel is active #5274
fix(spring-jakarta): [Queue Instrumentation 9] Clean up stale ThreadLocal context in Kafka consumer interceptor #5279
fix(spring-jakarta): [Queue Instrumentation 10] Fork root scopes and skip when OTel is active in Kafka consumer #5280
fix(spring-jakarta): [Queue Instrumentation 11] Guard entire span lifecycle in Kafka producer interceptor #5281
fix(spring-jakarta): [Queue Instrumentation 12] Add Kafka retry count attribute #5282
fix(spring-jakarta): [Queue Instrumentation 13] Align enqueue time with Python #5283
ref(kafka): [Queue Instrumentation 14] Extract sentry-kafka module #5288
feat(samples): [Queue Instrumentation 15] Add opt-in Kafka console e2e coverage #5289
fix(test): [Queue Instrumentation 16] Enable Kafka profile in system runner #5291

📜 Description

Add Kafka consumer instrumentation to sentry-spring-jakarta:

SentryKafkaRecordInterceptor — implements RecordInterceptor to create queue.process transactions for incoming Kafka records. Forks scopes per record for isolation (ISentryLifecycleToken lifecycle). Extracts sentry-trace and baggage headers for distributed tracing via continueTrace, and calculates messaging.message.receive.latency from the enqueued-time header. Composes with existing RecordInterceptor via delegation. Span lifecycle is managed through success/failure callbacks.
SentryKafkaConsumerBeanPostProcessor — registers the interceptor on ConcurrentKafkaListenerContainerFactory beans.

💡 Motivation and Context

Consumer-side instrumentation is needed to create process transactions and continue the distributed trace from the producer.

💚 How did you test it?

Unit tests for SentryKafkaRecordInterceptor and SentryKafkaConsumerBeanPostProcessor.

📝 Checklist

I added GH Issue ID & Linear ID
I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

⚠️ Merge this PR using a merge commit (not squash). Only the collection branch is squash-merged into main.

Add SentryKafkaRecordInterceptor that creates queue.process transactions for incoming Kafka records. Forks scopes per record, extracts sentry-trace and baggage headers for distributed tracing via continueTrace, and calculates messaging.message.receive.latency from the enqueued-time header. Composes with existing RecordInterceptor via delegation. Span lifecycle is managed through success/failure callbacks. Add SentryKafkaConsumerBeanPostProcessor to register the interceptor on ConcurrentKafkaListenerContainerFactory beans. Co-Authored-By: Claude <noreply@anthropic.com>

github-actions · 2026-04-01T14:27:22Z

Semver Impact of This PR

🟡 Minor (new features)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

New Features ✨

Spring Jakarta

[Queue Instrumentation 4] Add Kafka consumer instrumentation by adinauer in #5255

[Queue Instrumentation 3] Add Kafka producer instrumentation by adinauer in #5254

Other

(core) [Queue Instrumentation 1] Add enableQueueTracing option and messaging span data conventions by adinauer in #5250
(samples) [Queue Instrumentation 2] Add Kafka to Spring Boot 3 sample app by adinauer in #5253
Add strict trace continuation support by giortzisg in #5136
Sync file attachments to native by bitsandfoxes in #5211

Internal Changes 🔧

Deps

Bump requests from 2.32.4 to 2.33.0 in the uv group across 1 directory by dependabot in #5237
Bump github/codeql-action from 4.32.6 to 4.35.1 by dependabot in #5243

Other

Add THIRD_PARTY_NOTICES.md for vendored third-party code by markushi in #5186

_{🤖 This preview updates automatically when you update the PR.}

github-actions · 2026-04-01T14:27:26Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against f92f47c

sentry · 2026-04-01T14:29:56Z

Sentry Build Distribution

App Name	App ID	Version	Configuration	Install Page
SDK Size	io.sentry.tests.size	8.37.1 (1)	release	Install Build

Configure sentry-android build distribution settings

github-actions · 2026-04-01T14:48:28Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	390.41 ms	445.34 ms	54.93 ms
Size	0 B	0 B	0 B

Baseline results on branch: feat/queue-instrumentation-producer

Startup times

Revision	Plain	With Sentry	Diff
`d439efd`	323.43 ms	384.17 ms	60.73 ms
`6d877aa`	308.23 ms	348.66 ms	40.43 ms

App size

Revision	Plain	With Sentry	Diff
`d439efd`	0 B	0 B	0 B
`6d877aa`	0 B	0 B	0 B

Previous results on branch: feat/queue-instrumentation-consumer

Startup times

Revision	Plain	With Sentry	Diff
`651abdc`	250.50 ms	320.04 ms	69.54 ms
`5858973`	343.53 ms	436.53 ms	93.00 ms

App size

Revision	Plain	With Sentry	Diff
`651abdc`	0 B	0 B	0 B
`5858973`	0 B	0 B	0 B

…strumentation-consumer

…rning log Update SentryKafkaRecordInterceptor and its test to reference SentryProducerInterceptor instead of the removed SentryKafkaProducerWrapper. Add a warning log in SentryKafkaConsumerBeanPostProcessor when reflection fails to read the existing RecordInterceptor, so users know their custom interceptor may not be chained. Co-Authored-By: Claude <noreply@anthropic.com>

…strumentation-consumer

… ordering Add initForTest/close to SentryKafkaRecordInterceptorTest to fix NPE from TransactionContext constructor requiring initialized Sentry. Regenerate API file to fix alphabetical ordering of SentryProducerInterceptor entry. Co-Authored-By: Claude <noreply@anthropic.com>

adinauer · 2026-04-10T12:13:57Z

I investigated whether we should switch the consumer composition to Spring’s CompositeRecordInterceptor.

I don’t think we should for this case, because it is strictly weaker than our current wrapper behavior:

CompositeRecordInterceptor is not exception-shielded. Unlike CompositeProducerInterceptor, it does plain delegate calls for intercept/success/failure/afterRecord/setupThreadState/clearThreadState.
That means if a customer interceptor throws in success() or failure(), later delegates are skipped.
Our current SentryKafkaRecordInterceptor(delegate) uses try/finally around delegate success/failure, so Sentry transaction/lifecycle-token cleanup still runs even when delegate code throws.

Given the ThreadLocal/lifecycle-token leak risk we just fixed, that finally guarantee is important and CompositeRecordInterceptor doesn’t provide it.

lbloder · 2026-04-17T08:16:45Z

+      }
+
+      @SuppressWarnings("rawtypes")
+      final RecordInterceptor sentryInterceptor =


Any particular reason, we are going the composite route in the producer but adding the existing interceptor as a delegate here?

There is a CompositeRecordInterceptor

changelog

1f00027

adinauer mentioned this pull request Apr 1, 2026

feat(spring-boot-jakarta): [Queue Instrumentation 5] Add Kafka queue auto-configuration #5256

Merged

8 tasks

adinauer mentioned this pull request Apr 2, 2026

test(samples): [Queue Instrumentation 6] Add Kafka queue system tests #5258

Merged

8 tasks

adinauer force-pushed the feat/queue-instrumentation-consumer branch from 271fb8b to 1f00027 Compare April 2, 2026 05:37

adinauer and others added 4 commits April 9, 2026 13:14

Merge branch 'feat/queue-instrumentation-producer' into feat/queue-in…

2b74bab

…strumentation-consumer

Merge branch 'feat/queue-instrumentation-producer' into feat/queue-in…

6450f63

…strumentation-consumer

This was referenced Apr 13, 2026

ref(kafka): [Queue Instrumentation 14] Extract sentry-kafka module #5288

Draft

feat(samples): [Queue Instrumentation 15] Add opt-in Kafka console e2e coverage #5289

Draft

fix(test): [Queue Instrumentation 16] Enable Kafka profile in system runner #5291

Draft

lbloder reviewed Apr 17, 2026

View reviewed changes

Uh oh!

Conversation

adinauer commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Stack (Queue Instrumentation)

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

github-actions bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

New Features ✨

Spring Jakarta

Other

Internal Changes 🔧

Deps

Other

Uh oh!

github-actions bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sentry bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Sentry Build Distribution

Uh oh!

github-actions bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: feat/queue-instrumentation-producer

Startup times

App size

Previous results on branch: feat/queue-instrumentation-consumer

Startup times

App size

Uh oh!

adinauer commented Apr 10, 2026

Uh oh!

lbloder Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

lbloder Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

adinauer commented Apr 1, 2026 •

edited

Loading

github-actions bot commented Apr 1, 2026 •

edited

Loading

github-actions bot commented Apr 1, 2026 •

edited

Loading

sentry bot commented Apr 1, 2026 •

edited

Loading

github-actions bot commented Apr 1, 2026 •

edited

Loading